home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 19 / Night Owl (The Best of Shareware)(NOPV 19)(1996).ISO / 039a / pmuue131.zip / PMUUE.DOC < prev    next >
Text File  |  1995-08-04  |  10KB  |  237 lines
  1.                               PMUUE 1.31
  2.             Presentation Manager Unix-to-Unix Encoder/Decoder
  3.                             August 4, 1995
  4.  
  5. What is PMUUE?
  6. ==============
  7.  
  8. PMUUE stands for Presentation Manager Unix-to-Unix Encoder/Decoder.
  9. It is used to encode and decode Unix-to-Unix encoded files (commonly
  10. known as uuencoded files.)
  11.  
  12. Normally, it is not possible to send binary files through E-mail 
  13. because of the possibility of non-ASCII charaters being lost or 
  14. converted to other characters.  A utility, such as PMUUE, will 
  15. convert a binary file into a set of ASCII characters (uuencoded 
  16. format) which can be send through E-mail and converted back into 
  17. binary format once the destination is reached.
  18.  
  19. The Disclaimer
  20. ==============
  21.  
  22. There is no warranty, expressed or implied, with this program.  THE
  23. AUTHOR IS NOT RESPONSIBLE FOR ANY DAMAGES INCURRED BY USING THIS
  24. PROGRAM.  Use at your own risk!
  25.  
  26. Distribution
  27. ============
  28.  
  29. This program may distribute this program as long as 
  30.  
  31. a)      The archived file from which the program came from is distributed
  32.         and not altered in any way.
  33. b)      This program is not distributed with any commercial program.
  34.  
  35. Quick Start
  36. ===========
  37.  
  38. Here are the basic steps to DECODE a UUENCODED file:
  39.  
  40. 1.  Select "File|Decode..." from the menu or press Ctrl-D.
  41.  
  42. 2.  Select ALL the files you want to decode.  If a binary file is split 
  43.     between more than one UUENCODED file, you must make sure that those files
  44.     appear in the correct order in the list box.  You can only decode one
  45.     directory at a time.  Press Ctrl-/ in the file list box to select
  46.     all files in the current directory.
  47.  
  48. 3.  Select the "OK" button.
  49.  
  50.     NOTE: If the decoding did not work properly, you may have to change some 
  51.           of the settings in the "Preferences|Settings..." dialog box.
  52.  
  53. Here are the basic steps to ENCODE a binary file:
  54.  
  55. 1.  Select "File|Encode..." from the menu or press Ctrl-E.
  56.  
  57. 2.  Select ALL the files you want to encode.  You can only encode one
  58.     directory at a time.  Press Ctrl-/ in the file list box to select
  59.     all files in the current directory.
  60.  
  61. 3.  Select the "OK" button.
  62.  
  63.     NOTE: The format of the UUENCODED file is dependent on the current settings
  64.           of the "Preferences|Settings..." dialog box.
  65.  
  66. Parts of the PMUUE display
  67. ==========================
  68.  
  69. Besides the normal OS/2 system windows such as the title bar, the
  70. minimize and maximize buttons and the menu bar, there are two windows
  71. controlled by PMUUE and they are the log window and the status bar.
  72.  
  73. The log window is where any significant event has occured with regards
  74. to encoding or decoding a binary file.  Specifically, an entry is
  75. placed into the log window when:
  76.  
  77. -       A file is opened
  78. -       The process of encoding or decoding a file is started or finished
  79.  
  80. The log window keeps the last 500 events (by default) that has occured
  81. and deletes any log entries, starting from the oldest entry, that
  82. exceed the maximum number of entries allowed.  The log window
  83. automatically scrolls down to always show the latest event.
  84.  
  85. The status bar shows the last message sent to the log window but this 
  86. might change in future versions to include a progress indicator.
  87.  
  88. A dialog box appears whenever an encoding or decoding process is 
  89. complete, if desired.
  90.  
  91. The Menu Options
  92. ================
  93.  
  94. The File Menu
  95. -------------
  96.  
  97. The file menu allows the user to encode a file, decode a file, or exit 
  98. the program.
  99.  
  100. When the user selects the "Encode..." menu option or presses Ctrl-E on 
  101. the keyboard, the user is presented with a dialog box.  This dialog 
  102. box allows the user to select the binary file that he or she wants to 
  103. encode into uuencoded format.  The user can only select one or many
  104. files.  If the user selects "Cancel", the operation is aborted.  If
  105. the user selects "OK", then the encoding process is started.  A dialog
  106. box might appear when the encoding process is over.  Select "OK" to
  107. dismiss the dialog box.
  108.  
  109. The way the program encodes file can be determined by the Settings
  110. notebook.
  111.  
  112. When the user selects the "Decode..." menu option or presses Ctrl-D on 
  113. the keyboard, the user is presented with a dialog box.  This dialog 
  114. box allows the user to select the encoded file that he or she wants to 
  115. decode back into a binary file.  The user can select as many files as 
  116. he or she wants.  If the user select "Cancel", the operation is 
  117. aborted.  If the user selects "OK", then the operation is started.  
  118. Once the decoding process is finished, a dialog box will appear.  
  119. Select "OK" to dismiss the dialog box.
  120.  
  121. An encoded file does NOT have to be stripped of extraneous text in 
  122. order for PMUUE to decode it.  Also, the encoded file also does NOT 
  123. have to be split up if it contains more than one uuencoded file.
  124. Even if the binary file is split into many uuencoded files, these
  125. uuencoded files do NOT have to be joined together into one file.
  126. PMUUE will (hopefully) be smart enough to determine which lines are
  127. encoded and which are not and when an encoded file starts and ends.
  128.  
  129. When the user select "Exit" or double-clicks on the system menu icon 
  130. or selects "Close" from the system menu, the program will terminate.
  131.  
  132. The Preferences Menu
  133. --------------------
  134. The preferences has only one option, "Settings..." which will tell the
  135. program how to act in particular situations.  For a full explanation
  136. of the "Settings..." option, see "The Settings Notebook" elsewhere in
  137. this file.
  138.  
  139. The Help Menu
  140. -------------
  141. When the user selects "Help index...", the user is presented with all
  142. the major topics in the help file.
  143.  
  144. When the user selects "General Help...", the user sees the definitions
  145. of the major functions of this program.
  146.  
  147. When the user selects "Using Help...", a window with instructions on
  148. how to use help is presented.
  149.  
  150. When ther user select "Keys Help...", a window with valid keystrokes
  151. for the main window appears.
  152.  
  153. When the user select the "Product Information..." menu option, PMUUE 
  154. will show a dialog showing the program name and version as well as 
  155. other pertinent information about itself.
  156.  
  157. The Settings Notebook
  158. =====================
  159.  
  160. The settings notebook is divided into five pages: Notification, End of
  161. Line, Directories, Multi-part, and Miscellaneous.
  162.  
  163. The "Notification" page allows the user to select which output methods
  164. are used by the program.  The "Log" option specifies if the log window
  165. should be active.  The "Status Line" option specifies if the status
  166. line window should be used.  The "Message Box" option specifies if
  167. message windows should be used by the program for notification
  168. purposes.
  169.  
  170. The "End of Line" page specifies how an end-of-line marker should be
  171. like in a uuencoded file.  The "OS/2" option says that lines should
  172. end with a carriage return followed by a linefeed.  The "Unix" options
  173. says that lines should end with only a linefeed.
  174.  
  175. The "Directories" page specifies where the binary and uuencoded files
  176. should be and be placed.  The "Default Binary Directory" indicates
  177. where the binary files should be placed after decoding a uuencoded
  178. file.  The program will also look at that directory, by default, when
  179. starting up the "Encode..." menu option for the first time in the
  180. current session.  The "Default UUENCODE Directory" indicated where the
  181. uuencoded files should be placed after encoding a binary file.  The
  182. program will also look at that directory, by default, when starting up
  183. the "Decode..." menu option for the first in the currect session.
  184.  
  185. This page also has a "Default File Extension" file.  This field is
  186. used to add an extension to a uuencoded file when creating a uuencoded
  187. file except when the "Create multiple part encoding" option is used.
  188.  
  189. The "Multi-part" page specifies if multi-part uuencoded files should
  190. be created or not.  The "Create multiple part encoding" option
  191. indicates if PMUUE should split binary files into multiple uuencoded
  192. parts.  If this option is checked, then the rest of the options on the
  193. page are enabled.  The "Max. part size in KB" option specifies that
  194. the maximum size of each part should be limited by its size in
  195. kilobytes.  The maximum size should be entered to the field
  196. immediately to the right of this option.  The "Max. part size in
  197. lines" options specifies that the maximum size of each part should be
  198. limited by its size in the number of lines it has.  The maximum size
  199. should be entered to the field to the right of this option.
  200.  
  201. The maximum number of parts for either method of partitioning the file
  202. is 99 parts.  Each part of the encoded file will have an extension of
  203. ".u##" where ## is a number between 01 and 99.
  204.  
  205. The "Allow Multiple Part Decoding" checkbox specifies if PMUUE should
  206. assume that a binary file will be spread across multiple UUENCODED
  207. files.  If this checkbox is not on, then one UUENCODED file should
  208. contain at least one complete binary file.
  209.  
  210. The "Miscellaneous" page has two fields and a checkbox on it.  The
  211. "INI File" field indicates the name of the INI file that PMUUE should
  212. create and use to hold its settings in.  The "Max Log Length" field is
  213. the maximum number of lines that should be allowed in the log window.
  214. The "Allow Lowercase Characters" option specifies if PMUUE should
  215. allow lowercase characters as valid UUENCODED characters.  Normally,
  216. lowercase characters are not part of the code but some encoders allow
  217. lowercase characters as part of the encoding.  This could be
  218. troublesome if PMUUE decodes an ordinary line of text into the binary
  219. file.  If garbage appears in the binary file and this option is on,
  220. try turning this option off if no lowercase letters show up in the
  221. code or delete all the non-encoded lines of text in the source file.
  222.  
  223.  
  224. Command Line Options
  225. ====================
  226.  
  227. If filenames are specified on the command line when activating PMUUE,
  228. PMUUE will automatically decode those files using the settings in the
  229. INI file.  Wildcard specifications *are* accepted.  After decoding is
  230. complete, PMUUE will automatically close itself.
  231.  
  232. More command line options may be added in the future.
  233.  
  234. Happy encoding
  235.  
  236. Colin Vernon
  237.